wfm-ux

1.0.x
(0 reviews)

TMF622-PATCH-Update Special instructions

This operation allows to update special instructions for a product order for JM.

Key Considerations common for both HFC & FTTH Implementation

  1. BillingAccount field is mandatory to pass from input payload.
  2. All fields are required except for the Date field i.e., (note[0].date). If no date is provided, the system API will set the default value as current date and time.
  3. payload.note.text[0] will accept only 960 characters length from input. It will allow only Standard ASCII special characters (i.e., ",", "'", """), will not allow any non-ASCII (italian) special characters (i.e., "’", "“", "”", "à" etc.,). Also, it will not accept the "<" symbol.

Key Considerations specific to FTTH Implementation

  1. We recommend passing the Liberate User or employeeId (this has to be configured in liberate systems) in relatedParty.id where relatedParty.role = "authorizer"(static value) and relatedParty.@referredType = "Employee"(static value) in input payload, if not then ESB will assign a default value to update special instructions in Liberate. Please note that relatedParty.@referredType and relatedParty.role are static fields and values should not be changed

Key Considerations specific to HFC Implementation

  1. We recommend passing the Cerillion User in relatedParty.id where relatedParty.role = "authorizer"(static value) and relatedParty.@referredType = "Employee"(static value) in input payload, if not then ESB will assign a default value to update special instructions in Cerillion. Please note that relatedParty.@referredType and relatedParty.role are static fields and values should not be changed
URL
https://nonprod.esb.cloud.lla.com/test/wfm-ux/wfm-ux/v1/{businessId}/productOrder/{id}
URI Params
nametypedescriptionrequired
businessIdstring2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit.Y
idstringUnique identifier of the productOrderY
Headers
nametypedescriptionrequired
client_idstringThe client_id identifying the channel. Minimum characters: 5Y
client_secretstringPassword associated with the client_id. Minimum characters: 5Y
X-Correlation-IDstringIdentifier that correlates HTTP request between a client and server.
Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.		Y
cURL request for HFC-Cerillion
curl --location --request PATCH 'https://nonprod.esb.cloud.lla.com/test/wfm-ux/wfm-ux/v1/JM/productOrder/13757' \
--header 'client_id: 123' \
--header 'client_secret: 123' \
--header 'X-Correlation-ID: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b' \
--header 'Content-Type: application/json' \
--data-raw '{
    "relatedParty": [
        {
            "id": "SW172",
            "role": "authorizer",
            "@referredType": "Employee"
        }
    ],
    "note": [
        {
            "date": "2025-03-21T00:36:59.378-05:00",
            "text": "string"
        }
    ],
    "billingAccount": {
        "id": "37810101"
    }
}'
Response for HFC-Cerillion
{
    "relatedParty": [
        {
            "id": "SW172",
            "role": "authorizer",
            "@referredType": "Employee"
        }
    ],
    "note": [
        {
            "date": "2025-03-21T00:36:59.378-05:00",
            "text": "string"
        }
    ],
    "billingAccount": {
        "id": "37810101"
    }
}
cURL request for FTTH -Liberate
curl --location --request PATCH 'https://nonprod.esb.cloud.lla.com/test/wfm-ux/wfm-ux/v1/JM/productOrder/13788' \
--header 'client_id: 123' \
--header 'client_secret: 123' \
--header 'X-Correlation-ID: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b' \
--header 'Content-Type: application/json' \
--data-raw '{
    "relatedParty": [
        {
            "id": "99999",
            "role": "authorizer",
            "@referredType": "Employee"
        },
        {
            "id": "KNI",
            "role": "Department",
            "@referredType": "Company"
        }
    ],
    "note": [
        {
            "date": "2025-03-21T00:36:59.378-05:00",
            "text": "string"
        }
    ],
    "billingAccount": {
        "id": "123456777890"
    }
}'
Response for FTTH -Liberate
{
    "relatedParty": [
        {
            "id": "99999",
            "role": "authorizer",
            "@referredType": "Employee"
        },
        {
            "id": "KNI",
            "role": "Department",
            "@referredType": "Company"
        }
    ],
    "note": [
        {
            "date": "2025-03-21T00:36:59.378-05:00",
            "text": "string"
        }
    ],
    "billingAccount": {
        "id": "123456777890"
    }
}

Reviews